docs: clarify DitherMode::None is for pre-quantized graphics, not photos#50
Merged
g4bri3lDev merged 1 commit intoJul 6, 2026
Merged
Conversation
DitherMode::None does a direct nearest-color map with no error diffusion, so on limited palettes (especially BWR) continuous-tone or large flat mid-tone areas can map to an unexpected ink (e.g. a mid-gray region rendering as solid red). Document this in the Rust/Python/JS enum docs and the package READMEs, and steer users toward an error-diffusion mode for photographic input. Docs only; no logic or metric changes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012g2e8mr132vcizx92WsgiR
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarifies documentation for
DitherMode::None(NONE).Nonedoes a direct nearest-color map with no error diffusion. Because the OKLab nearest-color metric places a band of neutral grays closer to red ink than to black/white, on limited palettes (especially BWR) a continuous-tone image or a large flat mid-tone area can map to an unexpected ink — e.g. a solid mid-gray region rendering as solid red. This is by design, but it surprises users who applyNoneto continuous-tone photos.This PR documents that
Noneis intended for already-quantized / graphics input only, and steers users toward an error-diffusion mode (e.g. Floyd-Steinberg, Burkes) for photographic input.Docs/comments only — no logic or metric changes. Touches:
None/NONEvariant🤖 Generated with Claude Code
https://claude.ai/code/session_012g2e8mr132vcizx92WsgiR